Running in a Windows Console

The rhqctl.bat script is found in the <install-dir>/bin directory of the distribution. To run the RHQ Storage Node in a console, execute the command {{rhqctl.bat console --storage }}.

The rhqctl.bat script looks for specific environment variables during its execution. These variables can be modified to suit your system requirements. For example, you can point the RHQ Storage Node at a new JVM. The comments at the top of the rhqctl.bat and rhq-storage.bat files contain a detailed list of these environment variables. You do not have to set any specific variables to get the RHQ Storage Node run; sensible defaults are used.

Installing and Running as a Windows Service

When the RHQ Storage Node runs as a Windows service, it runs as a particular user. This user is specified by the RHQ_STORAGE_RUN_AS environment variable. The RHQ_STORAGE_RUN_AS_ME variable overrides the RHQ_STORAGE_RUN_AS variable and allows the RHQ Storage Node to run as the current user. If neither of these two variables are set, the RHQ Storage Node Windows Service runs as the System account. Both variables are explicitly mentioned here because of their security implications. All environment variables can be defined in the rhqctl.bat or rhq-storage.bat script. To run the RHQ Storage Node Windows service as a specific user, define the RHQ_STORAGE_RUN_AS variable with a value conforming to the strict Microsoft Windows format of: DOMAIN\username, for example, MYDOMAIN\john. Alternatively, define the RHQ_STORAGE_RUN_AS_ME variable - no value is required; the RHQ Storage Node runs as the username defined in the USERNAME environment variable. Execute the rhqctl.bat script with one of the following command line options:

• install - This installs the RHQ Storage Node as a Windows service. At the prompt, enter the password of the user designated to run the server. The Windows service now starts the server during the system boot. You can change this behavior by modifying the wrapper configuration file described below.

• start - This starts the Windows service, effectively starting the RHQ Storage Node. Ensure that you have run the rhqctl install --storage install command first. Alternatively, start the RHQ Storage Node by using the Windows Services Administrative Tool.

• stop - This stops the Windows Service, effectively stopping the RHQ Storage Node. You must have installed and started the Windows Service first in order to stop it. Alternatively, stop the RHQ Storage Node by using the Windows Services Administrative Tool instead.

• remove - This removes the Windows Service from your Windows operating system. If the service is running, it is first stopped. Once the service is removed, it is no longer started at boot time and you can no longer start it with the start option.

• status - If the service is installed, this option informs you if the server is currently running or not.

Setting Environment Variables

The rhqctl file, located in the <install-dir>/bin directory, contains a detailed list of the environment variables it requires to run. For most variables, sensible defaults are used and therefore do not need tweaking.

You can specify the path to the Java installation you want to use to run the RHQ Storage Node. Before starting the RHQ Storage Node, you can edit the rhqctl file and ensure that either the RHQ_SERVER_JAVA_HOME or the RHQ_SERVER_JAVA_EXE_FILE_PATH variable is set appropriately.

Running in a Console

To run the RHQ Storage Node in a console, execute the following commands as the root user:

# cd <install-dir>/bin
# ./rhqctl console --storage

Running with init.d

To ensure the RHQ Storage Node is started at boot time, the rhqctl script can be managed by the init process. The script must be copied to the appropriate location and the RHQ_SERVER_HOME variable must be set to the installation directory of the RHQ Storage Node. The exact procedure on how to do this varies between different flavors of UNIX. The example procedure below describes this process on Red Hat Enterprise Linux 5.2.

Service Installation on Red Hat Enterprise Linux 5.2

The rhqctl script can be placed under the /etc/init.d directory and managed by the service and chkconfig command. To run the RHQ Storage Node as a service on Red Hat Enterprise Linux 5.2 and ensure that it starts in run level 5, follow the procedure below as the root user:

1. Copy the rhqctl script into the /etc/init.d directory.

   cp <install-dir>/bin/rhqctl /etc/init.d

2. Edit the /etc/init.d/rhqctl script and set the RHQ_SERVER_HOME variable to the RHQ Storage Node install directory. For example:

   RHQ_SERVER_HOME=/opt/rhq/rhq-server-4.8.0

3. Edit the /etc/init.d/rhqctl script and add the following lines to the top of the file, directly under #!/bin/sh. The last two parameters in the #chkconfig: 2345 95 20 line specify the start and stop priority respectively; edit these accordingly.

   #!/bin/sh
   #chkconfig: 2345 95 20
   #description: RHQ Storage Node
   #processname: rhqctl

4. Add the service to the chkconfig service management command.

   # chkconfig --add rhqctl
   # chkconfig rhqctl --list

5. Ensure the service will start in run level 5.

   # chkconfig --level 5 rhqctl on

The RHQ Storage Node service can now be managed by the command:

service rhqctl { start | stop | status }

For example, to start the service, enter the following command:

# service rhqctl start